Skip to main content
`Ctrl`+`K`

# Toolkit Glossary

## General Terminology

NG911 Geodatabase

  A geodatabase intended to be submitted to a central repository for Next Generation 9-1-1 geospatial data.

Configuration File
config.yml
`config`

  YAML file containing the domains, fields, feature classes, and various other properties of Standards-compliant NG911 geodatabases in a structured format. This information is loaded into the Toolkit and exposed in the `ng911ok.lib.session.config` variable.

Required Feature Classes

  Feature classes that are required to exist in an NG911 Geodatabase: `
  ADDRESS_POINT` `
  DISCREPANCYAGENCY_BOUNDARY` `
  ESB_EMS_BOUNDARY` `
  ESB_FIRE_BOUNDARY` `
  ESB_LAW_BOUNDARY` `
  ESZ_BOUNDARY` `
  PSAP_BOUNDARY` `
  ROAD_CENTERLINE`

Required Feature Dataset

  A feature dataset, `
  NG911` in the NG911 Geodatabase that contains the required feature classes.

Optional Feature Classes

  Feature classes that may optionally exist in addition to the required feature classes in an NG911 Geodatabase: <None>

Optional Feature Dataset

  A feature dataset, `
  OptionalLayers` in the NG911 Geodatabase that contains the optional feature classes.

## Validation Terminology

Validation Function
Validation Method

  An instance method of `NG911Validator` which checks some aspect of the geodatabase for Standards compliance. These methods should typically take arguments as described in Conventions below and must always return a list of `ValidationErrorMessage` (or a subclass thereof) objects (or an empty list, if there are no issues).

Validation Routine

  An instance of `ValidationRoutine` that should be bound to `NG911Validator`. Routines are exposed as selectable options in the
  Validate Geodatabase tool, grouped by validation category. Generally, routines prepare and make calls to validation functions. For instantiation, see `@routine`.

Prerequisite Validation

  A validation function that must be passed in order to complete another validation function.

  See also

  `NG911Validator._precheck`

Validation Helper Function
Validation Helper Method

  A private method of `NG911Validator` that performs part of the logic of a validation function.

Validation Category

  The heading under which a validation routine appears in the geoprocessing tool interface.

Validation Issue

  A validation error, validation warning, or validation notice generated by the
  Validate Geodatabase tool and shown in TemplateCheckResults or FieldValuesCheckResults describing a problem or potential problem with the Standards-compliance of the NG911 geodatabase.

Severity

  Attribute of a validation issue denoting the importance of a validation issue. The three severities, from highest to lowest, are `Error`, `Warning`, and `Notice`. Corresponds to `ValidationErrorMessage.severity`.

Validation Error

  A validation issue of severity `Error`. These indicate that some aspect of the NG911 geodatabase is not in compliance with the Standards. Validation errors must be corrected before submission.

Validation Warning

  A validation issue of severity `Warning`. These indicate potential mistakes in the NG911 geodatabase. While a geodatabase may be submitted despite warnings, users are strongly encouraged to ensure that warnings are not indicative of an error in the data.

Validation Notice

  A validation issue of severity `Notice`. These indicate potential mistakes in the NG911 geodatabase that are more likely than validation warnings to actually be intentional and correct. A geodatabase with notices may be submitted.